<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>end(rtree&lt;...&gt; const &amp;)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Geometry">
<link rel="up" href="../group__rtree__functions.html" title="R-tree free functions (boost::geometry::index::)">
<link rel="prev" href="begin_rtree______const___.html" title="begin(rtree&lt;...&gt; const &amp;)">
<link rel="next" href="clear_rtree________.html" title="clear(rtree&lt;...&gt; &amp;)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="begin_rtree______const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__rtree__functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="clear_rtree________.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___"></a><a name="group__rtree__functions_1ga8fd1e53d8492643cbc9840ff715bb736"></a><a class="link" href="end_rtree______const___.html" title="end(rtree&lt;...&gt; const &amp;)">end(rtree&lt;...&gt;
          const &amp;)</a>
</h5></div></div></div>
<p>
            <a class="indexterm" name="idm45246415192352"></a>
Returns the iterator pointing at the end of the rtree values range.
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h0"></a>
            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.description"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.description">Description</a>
          </h6>
<p>
            This method returns the iterator which may be compared with the iterator
            returned by <a class="link" href="begin_rtree______const___.html#group__rtree__functions_1ga2467dc6ac90303496abd6ebd136eba18">begin()</a>
            in order to check if the iteration has ended.
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h1"></a>
            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.synopsis"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.synopsis">Synopsis</a>
          </h6>
<pre class="programlisting"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span></code><code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Value</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Parameters</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">IndexableGetter</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">EqualTo</span></code><code class="computeroutput"><span class="special">,</span></code>
         <code class="computeroutput"><span class="keyword">typename</span> <span class="identifier">Allocator</span></code><code class="computeroutput"><span class="special">&gt;</span></code>
<code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">IndexableGetter</span><span class="special">,</span> <span class="identifier">EqualTo</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;::</span><span class="identifier">const_iterator</span></code> <code class="computeroutput"><span class="identifier">end</span></code><code class="computeroutput"><span class="special">(</span></code><code class="computeroutput"><span class="identifier">rtree</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Parameters</span><span class="special">,</span> <span class="identifier">IndexableGetter</span><span class="special">,</span> <span class="identifier">EqualTo</span><span class="special">,</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span></code> <code class="computeroutput"><span class="identifier">tree</span></code><code class="computeroutput"><span class="special">)</span></code>
</pre>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h2"></a>
            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.returns"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.returns">Returns</a>
          </h6>
<p>
            The iterator pointing at the end of the range.
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h3"></a>
            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.example"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.example">Example</a>
          </h6>
<p>
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">bgi</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">bgi</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span>
<span class="comment">// the same as</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">tree</span><span class="special">),</span> <span class="identifier">do_something</span><span class="special">());</span>
</pre>
<p>
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h4"></a>
            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.iterator_category"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.iterator_category">Iterator
            category</a>
          </h6>
<p>
            ForwardIterator
          </p>
<h6>
<a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.h5"></a>
            <span class="phrase"><a name="geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.throws"></a></span><a class="link" href="end_rtree______const___.html#geometry.reference.spatial_indexes.group__rtree__functions.end_rtree______const___.throws">Throws</a>
          </h6>
<p>
            Nothing.
          </p>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../../doc/src/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
<tr><td align="left" valign="top"><p>
              The modification of the rtree may invalidate the iterators.
            </p></td></tr>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2009-2021 Barend Gehrels,
      Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="begin_rtree______const___.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../group__rtree__functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="clear_rtree________.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
